docs: Add sphinx API docs #164
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…markdown code fences, move info on API doc generation to proj. contrib.
tmathern
approved these changes
Sep 18, 2025
tmathern
requested changes
Sep 19, 2025
tmathern
reviewed
Sep 19, 2025
crandmck
had a problem deploying
to
github-pages
GitHub Actions
Failure
crandmck
had a problem deploying
to
github-pages
GitHub Actions
Failure
crandmck
had a problem deploying
to
github-pages
GitHub Actions
Failure
crandmck
temporarily deployed
to
pypipublish
GitHub Actions
Inactive
crandmck
had a problem deploying
to
github-pages
GitHub Actions
Failure
tmathern
temporarily deployed
to
github-pages
GitHub Actions
Inactive
|
@crandmck I configured the repo so you can test publish from this branch. Once you merge, let me know and I'll remove the config for this specific branch (and keep only main). It is also configured to run this workflow from the main branch when a Github release is created. I had test deployments that worked, see https://contentauth.github.io/c2pa-python/. Feel free to merge when you are happy with how the docs look. (Note that the branch will need to be up-to-date with latest main to allow merging). |
tmathern
approved these changes
Sep 20, 2025
* fix: 1 * fix: Update c2pa.py code * fix: Renamings * fix: Format
…' into add-sphinx-docs
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Ths PR adds a GH worfkow based on https://github.com/creator-assertions/creator-assertions.github.io/blob/main/.github/workflows/publish.yml, which will build the docs using Sphinx and deploy them to GH Pages for consumption. We can then link to that from the OS doc site.
Temp online preview of generated docs: https://crandmck.github.io/c2pa-python-docs/
Note:
scripts/generate_api_docs.pygenerates docs into theapi-docs/_build/htmldirectory (to separate them from the handwritten markdown docs).api-docs/conf.pydocs/project-contributions.mdsince (once we set up the automatic doc generation workflow) most users won't need to know how to generate the docs, unless contributing to the project.